home *** CD-ROM | disk | FTP | other *** search
/ The World of Computer Software / The World of Computer Software.iso / ddoor400.zip / DDOOR.TXT < prev    next >
Text File  |  1993-01-08  |  19KB  |  435 lines
  1.                          ======== ======   =======
  2.                             ==    ==   ==     ===
  3.                             ==    ==   ===   ===
  4.                             ==    ==   ==   ===
  5.                             ==    ======   =======
  6.  
  7.                    =======================================
  8.                    The DeAdZoNe Utilities for RemoteAccess
  9.                    =======================================
  10.                                         
  11.                                      D-DooR
  12.           Top-Door/Top-Door-User Statistics Generator for RemoteAccess
  13.                          Version 4.00   January 8, 1993
  14.                        (C) Copyright Victor Magdic 1991-93
  15.                                All Rights Reserved
  16.                                         
  17.  
  18.  
  19. Description
  20. -----------
  21. D-DooR is a program for RemoteAccess which will automatically track your door
  22. usage, and *who* is using them. It will generate "Top Door" stats, as well as
  23. "Top Door User" stats.  D-DooR is designed for use with RA 1.11 (use on future
  24. versions is not gauranteed).
  25.  
  26. IMPORTANT:    If you are upgrading from a version of D-DooR *prior* to 3.70 you
  27.               will have to erase your User-data file (DDOOR_NA.DAT) and start
  28.               over (note: you DO NOT have to erase your door-data-file
  29.               DDOOR_ID.DAT)
  30.  
  31.  
  32. Main Features
  33. -------------
  34.    *   Creates two bulletins: A "Top Door" bulletin and a "Top Door User"
  35.        bulletin. The number of doors/users displayed is fully configurable.
  36.    *   Built in configuration program makes setting up D-DooR a snap.
  37.    *   Supports an exclusion file, which allows you to specify up to 100 names
  38.        or handles which you want excluded from the "Top-Door-User" bulletin.
  39.    *   The Top-Door data file can be easily edited and changed at any time
  40.        using any text editor.
  41.    *   Old users can be purged based on the number of days since they last used
  42.        a door or the total number of doors they have used.
  43.    *   The Top-Door-User and Top-Door counters can be quickly and easily reset.
  44.    *   Shows how many days the statistics cover (e.g. last 50 days).
  45.    *   Supports conditional compiling of the bulletins, so that they are only
  46.        created if the door or user information has been updated. This can be a
  47.        real time-saver for sysops who like to generate the bulletins "on-the-
  48.        fly".
  49.    *   D-DooR will detect if a door is entered more than once in sequence by
  50.        the same user, and will not count it. This is useful for doors that need
  51.        to be entered more than once per call, and it also deters users from
  52.        trying to build up their stats by entering and exiting doors repeatedly.
  53.        This option can be temporarily disabled if necessary.
  54.    *   Supports Handles and Real Names.
  55.    *   Supports up to 99 doors.
  56.    *   Fully multi-node compatible.
  57.    *   D-DooR is completely free and requires no registration.
  58.  
  59.  
  60. How much does it cost?
  61. ----------------------
  62. This utility is FREE!  If you like it you can continue to use it for as long as
  63. you like free of charge!
  64.  
  65. If you do decide to use it, I would be excited to hear from you !! I encourage
  66. you to send me a postcard at the address listed below (see the end of this text
  67. file), or a message via netmail. It will cost you practically nothing, and will
  68. let me know you're enjoying the program. It will also give me incentive to keep
  69. improving the program and make it even better!
  70.  
  71. Or course donations are graciously accepted <grin>. See the address listed at
  72. the end of this document if you want to send a donation.
  73.  
  74.  
  75. D-DooR Maintenance Menu
  76. -----------------------
  77. By running DDOOR /C you can invoke the D-DooR maintenance Menu. From this menu
  78. you can configure D-DooR, as well as perform a number of other functions such as
  79. generating reports and resetting door counters.  These specific features will be
  80. explained in more detail below.
  81.  
  82.  
  83. Configuration
  84. -------------
  85. Choose "Configure D-DooR" from the menu and you will be presented with the
  86. configuration menu. Most of the options are self explanatory and only a few will
  87. be described below:
  88.  
  89.  
  90. TextFiles Directory      Where you want the D-DooR to generate the ANSI and ASCII
  91.                          bulletins.
  92.                          
  93. D-DooR Directory         If you want to keep all the D-DooR data files in a
  94.                          separate directory then specify it here. Otherwise D-
  95.                          DooR will use the main RA directory. (This option is
  96.                          included for those sysops prefer not to get their main
  97.                          RA directory cluttered.)
  98.                          
  99. Include Sysop in         If you want the sysop to be included in the door
  100. bulletin                 statistics turn this option on.
  101.                          
  102. Sysop Name in bulletin   If you want the sysop's name included at the top of the
  103.                          bulletin then turn this option. (Note: the name is use
  104.                          is whatever you have specified under "sysop name".)
  105.                          
  106. Use Handles              Choose YES to use handles when generating the bulletins.
  107.                          Choose NO to use real names.
  108.                          
  109. Use Exclusion File       If you want to use an exclusion file, turn this option
  110.                          on (see discussion on exclusion file later in the docs).
  111.                          
  112. Use Dupe detection       If you want to enable dupe detection turn this option
  113.                          on. (For an explanation of dupe detection see later in
  114.                          the docs).
  115.                          
  116. Date Stamp -Door         D-DooR will keep track of how many days the Door
  117. Bulletin                 statistics cover (e.g. the last 10 days or the last 50
  118.                          days). If you want to change this value you can do so
  119.                          here.
  120.                          
  121.                          Note: when you reset the Door Counters using the
  122.                          maintenance menu, this value is automatically reset to
  123.                          0.
  124.                          
  125. Date Stamp -Door User    D-DooR will keep track of how many days the Door-User
  126. Bulletin                 statistics cover (e.g. the last 10 days or the last 50
  127.                          days). If you want to change this value you can do so
  128.                          here.
  129.                          
  130.                          Note: when you reset the Door-User Counters using the
  131.                          maintenance menu, this value is automatically reset to
  132.                          0.
  133.                          
  134. Colour Scheme            Choose the colour scheme for generating the bulletins.1)
  135.                          Yellow/Red2) Cyan/Magenta3) 3-D shadow effect
  136.                          
  137. Conditional Compile      Choose whether you want D-DooR to use conditional
  138.                          compiles when generating the bulletins (see discussion
  139.                          of conditional compiling later in the docs).
  140.  
  141.  
  142.  
  143. Door Name Data File
  144. -------------------
  145. You must create a data file called DDOOR ID.DAT which contains formation about
  146. your doors. The file must be a plain ASCII textfile (Note: there is a sample
  147. DDOOR_ID.DAT file included which you can modify to suit your needs).
  148.  
  149. Each door which you want to keep track of has three lines of information
  150. ssociated with it, up to 99 doors can be specified in this way:
  151.  
  152.   Line 1.  Three letter code to identify the door
  153.   Line 2.  The door name (as you want it to appear in the bulletin).
  154.   Line 3.  The number of times the door has been accessed. When you are first
  155.             creating this file, set this value to 0.
  156.   
  157.   Example of DDOOR_ID.DAT:
  158.   
  159.             TW2                 <-- three letter code
  160.             TradeWars 2002      <-- door name
  161.             0                        <-- times used
  162.             AC6
  163.             Alpha Colony 6
  164.             0
  165.             YTR
  166.             Yankee Trader
  167.             0
  168.   
  169.   Comments
  170.   --------
  171.    *   Do not put any blank lines in the data file, and be sure you maintain
  172.        the proper order (id, doorname, times used).
  173.    *   You don't have to start the door counter at 0, you can start it at any
  174.        number you want. For example, if you have been running tradewars for
  175.        some time, you can make an estimate of how many times it has been used
  176.        and put that number in instead.
  177.    *   Since the data file is a plain ASCII text file, you can modify it at any
  178.        time and change the values.
  179.   
  180.   
  181.   Resetting the Door Counters
  182.   ---------------------------
  183.        The Door Counters in DDOOR_ID.DAT can be quickly reset from the
  184.        maintenance menu. This will change ALL the door counters to zero. (Note:
  185.        if for some reason you only want to set *some* of the door counters to
  186.        zero, you can do this manually by editing DDOOR_ID.DAT using a text
  187.        editor.)
  188.   
  189.        To bring up the maintenance menu run DDOOR with the /C switch. You will
  190.        be presented with a menu of choices. Choose "Reset Top Door Data File"
  191.        to reset the door counters.
  192.   
  193.   
  194. USER Data-File
  195. --------------
  196. D-DooR automatically maintains a file called DDOOR_NA.DAT which it uses to keep
  197. track of the Top-Door-Users.  You should not attempt to edit this file yourself
  198. because the results may be unpredictable. If you want to "reset" the top-door-
  199. user statistics you can do so using the D-DooR Maintenance Menu -choose "Reset
  200. Door-User Data File".
  201.   
  202. You can purge users from the User-Data-File based on the number of days since
  203. they last used a door or the total number of doors they have used.  This is done
  204. from the Maintenance utility -choose "Purge User Data File" and then you will be
  205. asked if you want to purge by days or by total.
  206.   
  207.    Note: Door will automatically create a backup file called DDOOR_NA.BAK
  208.          whenever you purge users from the data file. If you change your mind
  209.          after purging users, just copy this file back over the DDOOR_NA.DAT
  210.          file.
  211.  
  212.  
  213. Door User Report
  214. ----------------
  215. You can have D-DooR generate a Top-Door-User report by selecting this option in
  216. the D-DooR maintenance menu.  This report is simply a list of all the users in
  217. the D-DooR data file, as well as a information about how many doors they have
  218. used, and the how many days ago the last use was.  The report is created in a
  219. file called DDRUSER.LST and the directory you have specified as the D-DooR
  220. directory (see configuration above).
  221.  
  222.  
  223. Updating Door Counters
  224. ----------------------
  225. To update the counter for a particular door, run DDOOR in your batch file after
  226. you run the door and specify the three letter ID code that corresponds to that
  227. door on the command line.
  228.  
  229.      Example:  DDOOR AC6      Would update the counter for the door which
  230.                               corresponds to the id code "AC6" (Alpha Colony 6
  231.                               if you were using the example data file shown
  232.                               above)
  233.  
  234.    Comments
  235.    --------
  236.    *   If you enter an ID code that is not defined in the data file
  237.        (DDOOR_ID.DAT) it will simply be ignored.
  238.    *   The ID codes are not case sensitive, so AC6, ac6, and Ac6 would all be
  239.        treated the same.
  240.    *   You can run D-DooR before or after you run the door. If you are running
  241.        under a multi-node set-up and your batch file changes directories to run
  242.        the door, it is recommended that you run D-DooR *before* the door, so
  243.        that it can find the exitinfo.bbs file for that node.
  244.  
  245.  
  246. Dupe Checking
  247. -------------
  248. If you have configured D-DooR to do "Dupe Checking" then it will detect if a
  249. door is entered sequentially by the same user, and will not count it a second
  250. time.
  251.  
  252. You can always temporarily override the global setting by specifying /N after
  253. the three letter door id (this will ignore the dupe checking for the current
  254. door only).
  255.  
  256.     example: DDOOR TW2 /N     Will ignore global dupe checking for the current
  257.                               door update
  258.  
  259.  
  260. Generating Bulletins
  261. --------------------
  262. Bulletins are NOT automatically generated every time you update the door
  263. counter.  This is done in the interest of speed, since generating bulletins
  264. every time a user accesses a door can be time consuming, particularly if you
  265. have a slow hard drive.  (Note: if you want to generate bulletins after every
  266. door a method is explained below.)
  267.  
  268. In order to generate the bulletins you must use the /G parameter on the command
  269. line.
  270.  
  271.                Example:  DDOOR /G
  272.  
  273. This will create four files in the Textfiles directory (as specified in the
  274. configuration menu):
  275.  
  276.        DDOOR_ID.ANS    Ansi version of Top Doors Bulletin
  277.        DDOOR_ID.ASC    Ascii    "   "   "   "       "
  278.        DDOOR_NA.ANS    Ansi version of Top Door Users Bulletin
  279.        DDOOR_NA.ASC    Ascii  "     "   "   "     "      "
  280.  
  281.  
  282. Generating Stats after each Door
  283. --------------------------------
  284. It is recommended that you generate bulletins at least once per day in your
  285. daily maintenance routine.  If you don't mind the extra delay, and want to
  286. generate new bulletins after every door is used, just generate the bulletins
  287. separately after you update the door counter. For example, your batch file might
  288. look like this:
  289.  
  290.        REM batch file for TW2002 -game one
  291.        @echo off
  292.        cd \ra\doors\tw2002
  293.        tw2002 -qbbs
  294.        cd \ra
  295.        rem update door counter for Tradewars 2002
  296.        DDOOR TW2
  297.        rem generate bulletins
  298.        DDOOR /G
  299.  
  300.  
  301. Conditional Compile
  302. -------------------
  303. If you have configured D-DooR to do conditional compiles (see D-DooR
  304. configuration above) then D-DooR will only generate bulletins if the door or
  305. user stats have changed. This can be a real time-saver if you decide to generate
  306. bulletins "on-the-fly" -i.e. only when a user decides to view them.
  307.    
  308.    
  309. Exclusion List
  310. --------------
  311. D-DooR supports an exclusion list which allows you to specify up to 100 users
  312. which you do not want included in the bulletins. This is useful if have users
  313. (or co-sysops) which you want to "hide" from the bulletins.
  314.  
  315. In order to use this feature you must create a plain ASCII text file called
  316. DDOOR.CTL and simply list the name or handle of the user which you want excluded
  317. (one entry per line). You must also enable "Exclusion File Checking" in the
  318. configuration menu.
  319.    
  320.    Comments
  321.    --------
  322.    *   It is not necessary to specify both a user's real name and their handle
  323.        as separate entries, one or the other will suffice.
  324.    *   The entries in DDOOR.CTL are *not* case sensitive, so if you have "John
  325.        Smith" in your DDOOR.CTL file, and the user's name is actually spelt
  326.        "JoHn SmItH", the name will still be properly excluded.
  327.    *   If you have more than 100 entries in DDOOR.CTL, D-DooR will tell you so
  328.        and abort with an error message.
  329.    
  330.            Example of DDOOR.CTL:
  331.    
  332.                      John Smith
  333.                      Jane Smith
  334.                      The Punisher
  335.    
  336.    
  337. Location of Files
  338. -----------------
  339. In order for D-DooR to function properly, it is essential that you have the RA
  340. environment variable set (for more information on the RA environment variable
  341. see the RA docs).
  342.  
  343. DDOOR.EXE can be placed either in the main RA directory, or anywhere in your
  344. path (if you are running multi-node see below).  The DDOOR data files
  345. (DDOOR_ID.DAT,DDOOR_NA.DAT, and DDOOR.CTL) must go in the directory which you
  346. have specified as the 'D-DooR Directory' in the configuration.
  347.    
  348. D-DooR creates the following temporary files (in the 'D-DooR Directory'):
  349.    
  350.         DDOOR.DUP        Used to detect duplicate door usage by same user.
  351.         DDOOR_ID.TMP     Stores temporary door info. This files is removed when
  352.                          you generate the bulletins.
  353.         DDOOR_NA.TMP     Stores temporary user info. This file is removed when
  354.                          you generate the bulletins.
  355.  
  356.    
  357. Multi-Node Considerations
  358. -------------------------
  359. D-DooR uses information from EXITINFO.BBS to update the door-user counter, and
  360. it will look for EXITINFO in the current directory. This makes multi-node set-
  361. ups easy. All you have to do is run D-DooR from your node directory (where the
  362. exitinfo.bbs will be stored), and D-DooR will handle the rest. It's not
  363. necessary to have a copy of DDOOR.EXE in each node directory, provided that
  364. DDOOR.EXE is somewhere in your path.
  365.    
  366.    NOTE: Because D-DooR must be able to locate the exitinfo.bbs, if your door
  367.          batch file changes directories in order to run the door, it is
  368.          recommended that you run D-DooR before you execute the directory
  369.          change (otherwise D-DooR may not be able to find the files it needs).
  370.        
  371.        example:
  372.        
  373.           rem Game Multi-node  -run ddoor before the door
  374.           DDOOR gam
  375.           cd \ra\doors\game
  376.           game.exe
  377.           exit
  378.        
  379.        
  380. Legal Stuff and Disclaimer
  381. --------------------------
  382. "D-DooR" refers to the executables and documentation in the original
  383. distribution archive. D-DooR is copyrighted material by the author, Victor
  384. Magdic. All rights are reserved.  The author grants you a licence to use this
  385. software free of charge.
  386.  
  387. The program is provided "as is", without warranty or guarantee of any kind,
  388. either expressed or implied, as to its quality or performance. The author will
  389. not be held liable to you or anyone for any direct, indirect, incidental or
  390. consequential damages, including but not limited to any lost profits, or lost
  391. savings which may result from the use or inability to use this program.
  392.  
  393. The author is in no way obligated to provide future versions of this software.
  394.  
  395. Your use of the program constitutes your agreement to these terms and to this
  396. disclaimer.
  397.  
  398. All mentioned products are copyrighted by and trademarks of their respective
  399. holders.
  400.  
  401.        
  402. Credits
  403. -------
  404. Thanks to George Cedeno and James FitzGibbon for helping me beta test D-DooR.
  405. And a very special thanks to James for his numerous suggestions and helpful
  406. criticism.
  407.  
  408.  
  409. Updates
  410. -------
  411. Please see the enclosed file DEADZONE.TXT for information on how to obtain the
  412. latest version of D-DooR.
  413.  
  414.        
  415. Suggestions always welcome!
  416. ---------------------------
  417. If you have any suggestions for improvement or wish to report any bugs, you can
  418. reach me via netmail:
  419.        
  420.        The DeAdZoNe
  421.        Victor Magdic
  422.        FidoNet: 1:259/427
  423.        TeleNet Canada: 20:22/104
  424.        
  425.        or by writing to:
  426.        
  427.        Victor Magdic
  428.        424 Camden Circle
  429.        Mississauga, Ontario
  430.        L4Z 2P4
  431.        CANADA
  432.        
  433. ------------------------------------------------------------------ end
  434.        
  435.